From 155b479f61bd147de9ba69307cfe3302df3a8c68 Mon Sep 17 00:00:00 2001 From: parkrrrr Date: Fri, 19 May 2006 05:49:08 +0000 Subject: [PATCH] Moving lots of options --- gpsbabel/xmldoc/filters/discard.xml | 36 ++--- gpsbabel/xmldoc/filters/nuketypes.xml | 30 ++--- .../xmldoc/filters/options/discard-hdop.xml | 6 + .../filters/options/discard-hdopandvdop.xml | 7 +- .../xmldoc/filters/options/discard-vdop.xml | 6 + .../filters/options/nuketypes-routes.xml | 3 + .../filters/options/nuketypes-tracks.xml | 3 + .../filters/options/nuketypes-waypoints.xml | 4 + .../filters/options/polygon-exclude.xml | 5 + .../xmldoc/filters/options/polygon-file.xml | 15 +++ .../xmldoc/filters/options/position-all.xml | 7 + .../filters/options/position-distance.xml | 8 ++ .../filters/options/sort-description.xml | 7 + gpsbabel/xmldoc/filters/options/sort-gcid.xml | 7 + .../xmldoc/filters/options/sort-shortname.xml | 7 + gpsbabel/xmldoc/filters/options/sort-time.xml | 7 + .../xmldoc/filters/options/track-course.xml | 9 ++ gpsbabel/xmldoc/filters/options/track-fix.xml | 8 ++ .../xmldoc/filters/options/track-merge.xml | 13 ++ .../xmldoc/filters/options/track-move.xml | 12 ++ .../xmldoc/filters/options/track-pack.xml | 13 +- .../xmldoc/filters/options/track-speed.xml | 10 +- .../xmldoc/filters/options/track-split.xml | 122 +++++++++++++++++ .../xmldoc/filters/options/track-start.xml | 25 +++- .../xmldoc/filters/options/track-stop.xml | 14 ++ .../xmldoc/filters/options/track-title.xml | 11 +- gpsbabel/xmldoc/filters/polygon.xml | 102 ++++++++++----- gpsbabel/xmldoc/filters/position.xml | 31 ++--- gpsbabel/xmldoc/filters/sort.xml | 9 +- gpsbabel/xmldoc/filters/track.xml | 123 +----------------- gpsbabel/xmldoc/formats/options/an1-road.xml | 75 ++++++----- 31 files changed, 482 insertions(+), 253 deletions(-) diff --git a/gpsbabel/xmldoc/filters/discard.xml b/gpsbabel/xmldoc/filters/discard.xml index 232e2ea1d..962549f65 100644 --- a/gpsbabel/xmldoc/filters/discard.xml +++ b/gpsbabel/xmldoc/filters/discard.xml @@ -1,28 +1,12 @@ - - - This filter 'fixes' gps data by discarding points with - a hdop and/or vdop over a set limit. If you give both the - hdop and a vdop options, by default points that exceed EITHER - are discarded (OR). This filter processes waypoints, tracks, - and routes. + +This filter is used to "fix" unreliable GPS data by discarding points +with HDOP and/or VDOP above a specified limit. HDOP and VDOP are +measures of the best possible horizontal or vertical precision +for a given configuration of GPS satellites. - HDOP (float) - Points with a hdop exceeding the given value are - discarded. - - VDOP (float) - Points with a vdop exceeding the given value are - discarded. - HDOPANDVDOP - Only useful if both hdop and vdop are given. Now - logical AND is used, i.e. only points exceeding both given - values are discarded. - - Example: - gpsbabel \ - -i gpx -f in.gpx \ - -x discard,hdop=10,vdop=20,hdopandvdop \ - -o gpx -F out.gpx - - Contributed by Tobias Minich. + +Using the discard filter + gpsbabel -i gpx -f in.gpx -x discard,hdop=10,vdop=20,hdopandvdop -o gpx -F out.gpx + + Contributed by Tobias Minich. diff --git a/gpsbabel/xmldoc/filters/nuketypes.xml b/gpsbabel/xmldoc/filters/nuketypes.xml index 9f8c4569d..c0a26c40a 100644 --- a/gpsbabel/xmldoc/filters/nuketypes.xml +++ b/gpsbabel/xmldoc/filters/nuketypes.xml @@ -1,18 +1,16 @@ + +There are three main types of data that GPSBabel deals with: +waypoints, tracks, and routes. The nuketypes filter allows +removing all the data of any or all of those three types. + + +Filtering data types with nuketypes + +If you have a GPX file that contains routes, tracks, and +waypoints and you want a GPX file that contains only tracks, +you may use this filter to remove the waypoints with this command: + +gpsbabel -i gpx -f bigfile.gpx -x nuketypes,waypoints,routes -o gpx -F tracksonly.gpx + - - - There are three main types of data that GPSBabel deals with: - waypoints, tracks, and routes. The nuketypes filter allows - removing all the data of any or all of those three types. - - - Removes all waypoints. - - Removes all routes. - - Removes all routes. - - For example, if you have a GPX file that contains routes, tracks, and - waypoints and you want a GPX file that contains only tracks, - you can use this filter to remove the waypoints with this command: - - gpsbabel -i gpx -f bigfile.gpx -x nuketypes,waypoints,routes -o gpx -F tracksonly.gpx - diff --git a/gpsbabel/xmldoc/filters/options/discard-hdop.xml b/gpsbabel/xmldoc/filters/options/discard-hdop.xml index 8b1378917..8fcc16080 100644 --- a/gpsbabel/xmldoc/filters/options/discard-hdop.xml +++ b/gpsbabel/xmldoc/filters/options/discard-hdop.xml @@ -1 +1,7 @@ + +This option specifies the maximum allowable Horizontal Dilution of +Precision (HDOP). By default, any point with an HDOP in excess of +this value will be discarded regardless of its VDOP, but see +. + diff --git a/gpsbabel/xmldoc/filters/options/discard-hdopandvdop.xml b/gpsbabel/xmldoc/filters/options/discard-hdopandvdop.xml index 8b1378917..d07dd4144 100644 --- a/gpsbabel/xmldoc/filters/options/discard-hdopandvdop.xml +++ b/gpsbabel/xmldoc/filters/options/discard-hdopandvdop.xml @@ -1 +1,6 @@ - + +If this option is used, only points that exceed both the maximum +allowable HDOP and the maximum allowable VDOP will be discarded. This +option requires that both the and + options be specified. + diff --git a/gpsbabel/xmldoc/filters/options/discard-vdop.xml b/gpsbabel/xmldoc/filters/options/discard-vdop.xml index 8b1378917..f8701abd8 100644 --- a/gpsbabel/xmldoc/filters/options/discard-vdop.xml +++ b/gpsbabel/xmldoc/filters/options/discard-vdop.xml @@ -1 +1,7 @@ + +This option specifies the maximum allowable Vertical Dilution of +Precision (VDOP). By default, any point with an VDOP in excess of +this value will be discarded regardless of its HDOP, but see +. + diff --git a/gpsbabel/xmldoc/filters/options/nuketypes-routes.xml b/gpsbabel/xmldoc/filters/options/nuketypes-routes.xml index 8b1378917..9c70b59ba 100644 --- a/gpsbabel/xmldoc/filters/options/nuketypes-routes.xml +++ b/gpsbabel/xmldoc/filters/options/nuketypes-routes.xml @@ -1 +1,4 @@ + +This option causes the nuketypes filter to discard all route data. + diff --git a/gpsbabel/xmldoc/filters/options/nuketypes-tracks.xml b/gpsbabel/xmldoc/filters/options/nuketypes-tracks.xml index 8b1378917..536c9d6cc 100644 --- a/gpsbabel/xmldoc/filters/options/nuketypes-tracks.xml +++ b/gpsbabel/xmldoc/filters/options/nuketypes-tracks.xml @@ -1 +1,4 @@ + +This option causes the nuketypes filter to discard all track data. + diff --git a/gpsbabel/xmldoc/filters/options/nuketypes-waypoints.xml b/gpsbabel/xmldoc/filters/options/nuketypes-waypoints.xml index 8b1378917..26c71901e 100644 --- a/gpsbabel/xmldoc/filters/options/nuketypes-waypoints.xml +++ b/gpsbabel/xmldoc/filters/options/nuketypes-waypoints.xml @@ -1 +1,5 @@ + +This option causes the nuketypes filter to discard all waypoints that are not +associated with a track or route. + diff --git a/gpsbabel/xmldoc/filters/options/polygon-exclude.xml b/gpsbabel/xmldoc/filters/options/polygon-exclude.xml index 8b1378917..6a68bdfa2 100644 --- a/gpsbabel/xmldoc/filters/options/polygon-exclude.xml +++ b/gpsbabel/xmldoc/filters/options/polygon-exclude.xml @@ -1 +1,6 @@ + +When this option is specified, the usual sense of the polygon filter is +reversed. That is, points that are inside the polygon are discarded +while points that are further away are kept. + diff --git a/gpsbabel/xmldoc/filters/options/polygon-file.xml b/gpsbabel/xmldoc/filters/options/polygon-file.xml index 8b1378917..032b595c1 100644 --- a/gpsbabel/xmldoc/filters/options/polygon-file.xml +++ b/gpsbabel/xmldoc/filters/options/polygon-file.xml @@ -1 +1,16 @@ + +This option is required. + + +This option specifies the name of the file containing the polygon to use for +filtering. The format of the file is as described above. + + +GPSBabel supports converting any route or track to a file usable by this +filter; simply read it in the normal way and write it using the +arc file format. Afterward, you will +need to make sure that the first point and the last point in the +file are the same, as the polygon filter depends on that. You can do so +with any text editor. + diff --git a/gpsbabel/xmldoc/filters/options/position-all.xml b/gpsbabel/xmldoc/filters/options/position-all.xml index 8b1378917..16e59e5a8 100644 --- a/gpsbabel/xmldoc/filters/options/position-all.xml +++ b/gpsbabel/xmldoc/filters/options/position-all.xml @@ -1 +1,8 @@ + +This option causes the position filter to remove all points that are within +the specified distance of one another, rather than leaving just one of them. + + +This option may be used to entirely remove clusters of points. + diff --git a/gpsbabel/xmldoc/filters/options/position-distance.xml b/gpsbabel/xmldoc/filters/options/position-distance.xml index 8b1378917..ebd18d5d9 100644 --- a/gpsbabel/xmldoc/filters/options/position-distance.xml +++ b/gpsbabel/xmldoc/filters/options/position-distance.xml @@ -1 +1,9 @@ + +This option specifies the minimum allowable distance between two points. If +two points are closer than this distance, only one of them is kept. + + +Distances may be expressed in feet (30f) or meters (10m). If no unit is +specified, the distance is assumed to be in feet. + diff --git a/gpsbabel/xmldoc/filters/options/sort-description.xml b/gpsbabel/xmldoc/filters/options/sort-description.xml index 8b1378917..c629fce01 100644 --- a/gpsbabel/xmldoc/filters/options/sort-description.xml +++ b/gpsbabel/xmldoc/filters/options/sort-description.xml @@ -1 +1,8 @@ + +This option causes the waypoints to be sorted in alphabetical order by +description. + + +This option is not valid in combination with any other option. + diff --git a/gpsbabel/xmldoc/filters/options/sort-gcid.xml b/gpsbabel/xmldoc/filters/options/sort-gcid.xml index 8b1378917..c2431b778 100644 --- a/gpsbabel/xmldoc/filters/options/sort-gcid.xml +++ b/gpsbabel/xmldoc/filters/options/sort-gcid.xml @@ -1 +1,8 @@ + +If the data contains Groundspeak geocache IDs, this option causes the +waypoints to be sorted in alphabetical order by geocache ID. + + +This option is not valid in combination with any other option. + diff --git a/gpsbabel/xmldoc/filters/options/sort-shortname.xml b/gpsbabel/xmldoc/filters/options/sort-shortname.xml index 8b1378917..cd4075ccb 100644 --- a/gpsbabel/xmldoc/filters/options/sort-shortname.xml +++ b/gpsbabel/xmldoc/filters/options/sort-shortname.xml @@ -1 +1,8 @@ + +This option causes the waypoints to be sorted in alphabetical order by +short name. + + +This option is not valid in combination with any other option. + diff --git a/gpsbabel/xmldoc/filters/options/sort-time.xml b/gpsbabel/xmldoc/filters/options/sort-time.xml index 8b1378917..c43f60902 100644 --- a/gpsbabel/xmldoc/filters/options/sort-time.xml +++ b/gpsbabel/xmldoc/filters/options/sort-time.xml @@ -1 +1,8 @@ + +This option causes the waypoints to be sorted in chronological order by +creation time. + + +This option is not valid in combination with any other option. + diff --git a/gpsbabel/xmldoc/filters/options/track-course.xml b/gpsbabel/xmldoc/filters/options/track-course.xml index 8b1378917..36b83f29a 100644 --- a/gpsbabel/xmldoc/filters/options/track-course.xml +++ b/gpsbabel/xmldoc/filters/options/track-course.xml @@ -1 +1,10 @@ + +This option computes (or recomputes) a value for the GPS heading at each +trackpoint. This is most useful with trackpoints from formats that don't +support heading information or for trackpoints synthesized by the +interpolate +filter. The heading at each trackpoint is simply the course from the +previous trackpoint in the track. The first trackpoint in each track +is arbitrarily assigned a heading of 0 degrees. + diff --git a/gpsbabel/xmldoc/filters/options/track-fix.xml b/gpsbabel/xmldoc/filters/options/track-fix.xml index 8b1378917..4cd9f303a 100644 --- a/gpsbabel/xmldoc/filters/options/track-fix.xml +++ b/gpsbabel/xmldoc/filters/options/track-fix.xml @@ -1 +1,9 @@ + +This option sets the GPS fix status for all trackpoints to the specified +value. Valid values for this option are PPS, DGPS, 3D, 2D, or NONE. + + +This option is most useful when converting from a format that doesn't +contain GPS fix status to one that requires it. + diff --git a/gpsbabel/xmldoc/filters/options/track-merge.xml b/gpsbabel/xmldoc/filters/options/track-merge.xml index 8b1378917..5ca5bbbf9 100644 --- a/gpsbabel/xmldoc/filters/options/track-merge.xml +++ b/gpsbabel/xmldoc/filters/options/track-merge.xml @@ -1 +1,14 @@ + +This option puts all track points from all tracks into a single track +and sorts them by time stamp. Points with identical time stamps will be +dropped. + + +Merging tracks with the track filter + +Suppose you want to merge tracks recorded with two different GPS devices +at the same time. To do that, use this command line: + +gpsbabel -t -i gpx -f john.gpx -i gpx -f doe.gpx -x track,merge,title="COMBINED LOG" -o gpx -F john_doe.gpx + diff --git a/gpsbabel/xmldoc/filters/options/track-move.xml b/gpsbabel/xmldoc/filters/options/track-move.xml index 8b1378917..0641de1e9 100644 --- a/gpsbabel/xmldoc/filters/options/track-move.xml +++ b/gpsbabel/xmldoc/filters/options/track-move.xml @@ -1 +1,13 @@ + +This option changes the time of all trackpoints. This might be useful if +your track must be moved by one or more hours because of an incorrect +time zone. + + +Time-shifting a track with the track filter + +The following command line will shift all tracks to be one hour later. + +gpsbabel -t -i gpx -f in.gpx -x track,move=+1h -o gpx -F out.gpx + diff --git a/gpsbabel/xmldoc/filters/options/track-pack.xml b/gpsbabel/xmldoc/filters/options/track-pack.xml index 8b1378917..c65f6893f 100644 --- a/gpsbabel/xmldoc/filters/options/track-pack.xml +++ b/gpsbabel/xmldoc/filters/options/track-pack.xml @@ -1 +1,12 @@ - + +This option causes all tracks to be appended to one another to form a single +track. This option does not work if any two tracks overlap in time; in that +case, consider using the option. + + +This option is most useful for rejoining tracks that might have +been interrupted by an equipment malfunction or an overnight stop. + + +If no other option is given to the track filter, this option is assumed. + diff --git a/gpsbabel/xmldoc/filters/options/track-speed.xml b/gpsbabel/xmldoc/filters/options/track-speed.xml index 8b1378917..32d640bdf 100644 --- a/gpsbabel/xmldoc/filters/options/track-speed.xml +++ b/gpsbabel/xmldoc/filters/options/track-speed.xml @@ -1 +1,9 @@ - + +This option computes a value for the GPS speed at each trackpoint. +This is most useful with trackpoints from formats that don't support +speed information or for trackoints synthesized by the +interpolate +filter. The speed at each trackpoint is the average speed from the +previous trackpoint (distance divided by time). The first trackpoint +in each track is assigned a speed of "unknown." + diff --git a/gpsbabel/xmldoc/filters/options/track-split.xml b/gpsbabel/xmldoc/filters/options/track-split.xml index 8b1378917..6db49a790 100644 --- a/gpsbabel/xmldoc/filters/options/track-split.xml +++ b/gpsbabel/xmldoc/filters/options/track-split.xml @@ -1 +1,123 @@ + + ( !!! This filter always drops empty tracks !!! ) + + The track filter is a tool for manipulating track lists. The +following options are available: + TITLE + Gives the new track(s) a basic title. Basic means if + more than one track is created by filter the title will be + expanded with the date the new track. Special formats (see + UNIX date or strftime for details) are possible. + + +gpsbabel -t \ + -i gpx -f in.gpx \ -x track,pack,split,title="ACTIVE LOG-%D" \ +-o gpx -F out.gpx PACK + + MOVE + Change the time of all trackpoints. This is useful if + your track has moved by one or more hours through a time zone + problem. The following example will shift your track to be + one hour later. + +gpsbabel -t -i gpx -f in.gpx \ + -x track,move=+1h,pack,title="ACTIVE LOG" \ + -o gpx -F out.gpx + START / STOP + Filter tracks against time borders. All points outside + this range will be dropped. The date-time paramters have to + be in form of YYYYMMDDHHMMSS; but you may specify only the + most significant portion represented in the the leftmost + fields. See the example, where the time is specified only + through the hour. If you only want to get a track mapped on + 20 july 2005 from 10 am to 6pm, you should use this: + +gpsbabel -t -i gpx -f in.gpx -x \ + track,start=2005072010,stop=2005072018 \ + -o gpx -F out.gpx + PACK + With this default option all tracks from input will be + packed into one track. If tracks overlaps in time, the filter + stops working. To pack all the tracks together into one + track and give it a name, use this: + +gpsbabel -t -i gpx -f in.gpx -x track,pack,title="ACTIVE LOG" \ + -o gpx -F out.gpx + SPLIT + The input track will be split into several tracks + depending on date of track points. If there is more than one + track, use the pack option before before using this. To + split a single tracks into separate tracks for each day and + name them, use this: + + +gpsbabel -t -i gpx -f in.gpx -x \ + track,split,title="ACTIVE LOG \ + # %Y%m%d" -o gpx -F out.gpx + If the input has multiple tracks, pack them together before +splitting them back apart per day thusly: + +gpsbabel -t -i gpx -f in.gpx \ + -x track,pack,split,title="ACTIVE LOG # %D" \ + -o gpx -F out.gpx + Additionally you can add an interval to the split + option. With this the track will be split if the time + between two points is greater than this parameter. The + interval must be numeric and can be int days, hours, minutes + or seconds, expressed as one of the character "d", "h", "m", + or "s". If no trailing character is present, the units are + assumed to be in seconds. + + For example, to split a track based on an four hour + interval, use this: + +gpsbabel -t \ + -i gpx -f in.gpx \ + -x track,pack,split=4h,title="LOG # %c" \ + -o gpx -F out.gpx + + MERGE + Merge puts all track points into one single track and + sort them by time. Points with identical time stamp will be + dropped !!! + If you want to merge tracks from different devices but + from same trip, use this: + +gpsbabel -t \ + -i gpx -f john.gpx \ + -i gpx -f doe.gpx \ + -x track,merge,title="COMBINED LOG" \ + -o gpx -F john_doe.gpx + + FIX + Fix forces the GPS fix status for all trackpoints to the + specified value. The value may be PPS, DGPS, 3D, 2D, or NONE. + + + gpsbabel -i gpx -f trk.gpx -x track,fix=3D -o nmea -F - + + + COURSE + Course computes a value for the GPS heading at each trackpoint. + This is most useful with trackpoints from formats that don't support + heading information or for trackpoints synthesized by the interpolate + filter. The heading at each trackpoint is simply the course from the + previous trackpoint in the track. The first trackpoint in each track + is arbitrarily assigned a heading of 0 degrees. + + gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F - + + + SPEED + Course computes a value for the GPS speed at each trackpoint. + This is most useful with trackpoints from formats that don't support + speed information or for trackoints synthesized by the interpolate + filter. The speed at each trackpoint is the average speed from the + previous trackpoint (distance/time). The first trackpoint in each + track is assigned a speed of "unknown." + + gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F - + + + diff --git a/gpsbabel/xmldoc/filters/options/track-start.xml b/gpsbabel/xmldoc/filters/options/track-start.xml index 8b1378917..9df4086fd 100644 --- a/gpsbabel/xmldoc/filters/options/track-start.xml +++ b/gpsbabel/xmldoc/filters/options/track-start.xml @@ -1 +1,24 @@ - + +This option is used along with the to discard +trackpoints that were recorded outside of a specific period of time. +This option specifies the beginning of the time period. + + +If this option is not specified, the time period is assumed to begin at the +dawn of time or January 1, 1970, whichever was later. The time for this +option is expressed in UTC. + + +The value of this option must be in the form of YYYYMMDDHHMMSS, but it is +not necessary to specify the smaller time units if they are not needed. +That is, if you only care about points logged between 10 AM and 6 PM on a +given date, you need not specify the minutes or seconds. + + +Extracting a period of time with the track filter + +To get only the parts of a track that were mapped on 20 July 2005 +between 10 AM and 6 PM, use this command line: + +gpsbabel -t -i gpx -f in.gpx -x track,start=2005072010,stop=2005072018 -o gpx -F out.gpx + diff --git a/gpsbabel/xmldoc/filters/options/track-stop.xml b/gpsbabel/xmldoc/filters/options/track-stop.xml index 8b1378917..a86755aeb 100644 --- a/gpsbabel/xmldoc/filters/options/track-stop.xml +++ b/gpsbabel/xmldoc/filters/options/track-stop.xml @@ -1 +1,15 @@ + +This option is used in conjunction with the option to +discard all trackpoints outside of a given period of time. This option +defines the end of the time period. + + +If this option is not specified, the time period is assumed to end at the +end of civilization as we know it or the year 2038, whichever comes first. +The time for this option is expressed in UTC. + + +See the option for the format of this value and an +example of usage. + diff --git a/gpsbabel/xmldoc/filters/options/track-title.xml b/gpsbabel/xmldoc/filters/options/track-title.xml index 8b1378917..be578bd46 100644 --- a/gpsbabel/xmldoc/filters/options/track-title.xml +++ b/gpsbabel/xmldoc/filters/options/track-title.xml @@ -1 +1,10 @@ - + +This option specifies a title for tracks generated by the track filter. +By default, the title of the new track is composed of the start time of +the track appended to this value. + + +If this value contains a percent (%) character, it is treated as a format +string for the POSIX strftime function, allowing custom time-based +track names. + diff --git a/gpsbabel/xmldoc/filters/polygon.xml b/gpsbabel/xmldoc/filters/polygon.xml index 84405b9ba..a193f903e 100644 --- a/gpsbabel/xmldoc/filters/polygon.xml +++ b/gpsbabel/xmldoc/filters/polygon.xml @@ -1,36 +1,78 @@ - - - The polygon filter includes points if they are inside - of a polygon. A polygon file looks like an arc file, except - that the arc it describes must be a closed cycle. That is, - for a simple polygon, the first and last points must be the - same. Here's a square: + +The polygon filter includes points if they are inside +of a polygon. A polygon file looks like an +arc file, except +that the arc it describes must be a closed cycle. That is, +for a simple polygon, the first and last points must be the +same. Here's a square: + + +# A square (not really) polygon +41.0000 -85.0000 +41.0000 -86.0000 +42.0000 -86.0000 +42.0000 -85.0000 +41.0000 -85.0000 + + +Polygons may include islands and holes. To include an +island or a hole, just append it to the main polygon. - - # A square (not really) polygon - 41.0000 -85.0000 - 41.0000 -86.0000 - 42.0000 -86.0000 - 42.0000 -85.0000 - 41.0000 -85.0000 + +# A square polygon with a triangular hole +41.0000 -85.0000 +41.0000 -86.0000 +42.0000 -86.0000 +42.0000 -85.0000 +41.0000 -85.0000 +# The hole begins here +41.5000 -85.5000 +41.6000 -85.5000 +41.6000 -85.6000 +41.5000 -85.5000 - Polygons may include islands and holes. To specify an - island or a hole, just append it to the main polygon. + +As with the arc filter, you define a polygon by +giving the name of the file that contains it, using +the option. - As with the arc filter, you specify a polygon by - specifying the name of the file that contains it, using - the file option. You can also specify the exclude option, - which reverses the operation of the filter so that it only - includes points that are NOT in the polygon. + +Note that this filter currently will not work properly +if your polygon contains one or both poles or if it spans the +line of 180 degrees east or west longitude. - Note that this filter currently will not work properly - if your polygon contains one or both poles or if it spans the - line of 180 degrees east or west longitude. + +Using the polygon filter + +Suppose you have a polygon file that defines the border of your county, +called mycounty.txt. This command line will give you only the points +in your county: - For example, assume you have a polygon file that - defines the border of your county, called mycounty.txt. This - command line will give you only the points in your county: +gpsbabel -i geo -f 1.loc -x polygon,file=mycounty.txt -o mapsend -F 2.wpt + + +Using the polygon and arc filters to find points in or nearly in a +polygon + +Because the polygon and arc filters use +the same file format, you can use them together to find all points that are +"in or nearly in" a polygon. This can be useful if your waypoints or the +boundaries of your polygon are not quite perfect, so you want to provide a +buffer zone around it in case there are points nearby that should be in the +polygon but aren't quite. - gpsbabel -i geo -f 1.loc -x polygon,file=mycounty.txt \ --o mapsend -F 2.wpt - + +gpsbabel -i gpx -f points.gpx -x stack,push -x polygon,file=mycounty.txt +-x stack,swap -x arc,file=mycounty.txt,distance=1k -x stack,pop,append +-x duplicate,shortname -o gpx -F nearmycounty.gpx + + +This command makes a copy of the points, finds the ones that are in your +your county, swaps that result with the copy of the original set of points, +finds the ones from that set that are within 1 km of the border of the county, +puts the two lists together, and then filters out any points that appear twice +(This step is necessary because points inside the county but near the county +line will be kept by both the polygon and the arc filter.) + + + diff --git a/gpsbabel/xmldoc/filters/position.xml b/gpsbabel/xmldoc/filters/position.xml index a80105fec..13ff374a0 100644 --- a/gpsbabel/xmldoc/filters/position.xml +++ b/gpsbabel/xmldoc/filters/position.xml @@ -1,20 +1,15 @@ + +This filter removes points based on their proximity to each other. A +point is removed if it is within the specified distance of a point that +has come before. + - - The position filter is designed to remove points based - on their proximity to each other. Distances can be passed on - the command line by passing the distance=XXX option to the - filter. Distance options may be expressed in feet - (distance=3f) or - meters (distance=1m). - The default is zero feet, essentially a duplicate position. - - - Using position filter to suppress close points - gpsbabel -i geo -f 1.loc -f 2.loc -x position,distance=1f \ - -o mapsend -F 3.wpt - - would remove multiple points that are within 1 foot of - each other, leaving just one. - You can also specify the "all" option, which would - remove all of the points rather than leaving one. + +Using the position filter to suppress close points + +The following command removes multiple points that are within +one foot of each other, leaving just one. + +gpsbabel -i geo -f 1.loc -f 2.loc -x position,distance=1f -o mapsend -F 3.wpt + diff --git a/gpsbabel/xmldoc/filters/sort.xml b/gpsbabel/xmldoc/filters/sort.xml index eb474b7ec..da4ad375e 100644 --- a/gpsbabel/xmldoc/filters/sort.xml +++ b/gpsbabel/xmldoc/filters/sort.xml @@ -1,8 +1,5 @@ - - - This simple filter allows you to alphabetize waypoints - by shortname or by description. It has a special suboption - (gcid) to sort by geocaching.com waypoint ID's when the input - comes from a GPX file that has GC numbers in it. + +This filter sorts waypoints into alphabetical order by the selected field. +You must specify exactly one of the options. diff --git a/gpsbabel/xmldoc/filters/track.xml b/gpsbabel/xmldoc/filters/track.xml index 6db49a790..cf6c39494 100644 --- a/gpsbabel/xmldoc/filters/track.xml +++ b/gpsbabel/xmldoc/filters/track.xml @@ -1,123 +1,8 @@ - - - ( !!! This filter always drops empty tracks !!! ) - - The track filter is a tool for manipulating track lists. The -following options are available: - TITLE - Gives the new track(s) a basic title. Basic means if - more than one track is created by filter the title will be - expanded with the date the new track. Special formats (see - UNIX date or strftime for details) are possible. + +WARNING: This filter always drops empty tracks. - -gpsbabel -t \ - -i gpx -f in.gpx \ -x track,pack,split,title="ACTIVE LOG-%D" \ --o gpx -F out.gpx PACK - - MOVE - Change the time of all trackpoints. This is useful if - your track has moved by one or more hours through a time zone - problem. The following example will shift your track to be - one hour later. - -gpsbabel -t -i gpx -f in.gpx \ - -x track,move=+1h,pack,title="ACTIVE LOG" \ - -o gpx -F out.gpx - START / STOP - Filter tracks against time borders. All points outside - this range will be dropped. The date-time paramters have to - be in form of YYYYMMDDHHMMSS; but you may specify only the - most significant portion represented in the the leftmost - fields. See the example, where the time is specified only - through the hour. If you only want to get a track mapped on - 20 july 2005 from 10 am to 6pm, you should use this: - -gpsbabel -t -i gpx -f in.gpx -x \ - track,start=2005072010,stop=2005072018 \ - -o gpx -F out.gpx - PACK - With this default option all tracks from input will be - packed into one track. If tracks overlaps in time, the filter - stops working. To pack all the tracks together into one - track and give it a name, use this: - -gpsbabel -t -i gpx -f in.gpx -x track,pack,title="ACTIVE LOG" \ - -o gpx -F out.gpx - SPLIT - The input track will be split into several tracks - depending on date of track points. If there is more than one - track, use the pack option before before using this. To - split a single tracks into separate tracks for each day and - name them, use this: - - -gpsbabel -t -i gpx -f in.gpx -x \ - track,split,title="ACTIVE LOG \ - # %Y%m%d" -o gpx -F out.gpx - If the input has multiple tracks, pack them together before -splitting them back apart per day thusly: - -gpsbabel -t -i gpx -f in.gpx \ - -x track,pack,split,title="ACTIVE LOG # %D" \ - -o gpx -F out.gpx - Additionally you can add an interval to the split - option. With this the track will be split if the time - between two points is greater than this parameter. The - interval must be numeric and can be int days, hours, minutes - or seconds, expressed as one of the character "d", "h", "m", - or "s". If no trailing character is present, the units are - assumed to be in seconds. + +This filter performs various operations on track data. - For example, to split a track based on an four hour - interval, use this: - -gpsbabel -t \ - -i gpx -f in.gpx \ - -x track,pack,split=4h,title="LOG # %c" \ - -o gpx -F out.gpx - - MERGE - Merge puts all track points into one single track and - sort them by time. Points with identical time stamp will be - dropped !!! - If you want to merge tracks from different devices but - from same trip, use this: - -gpsbabel -t \ - -i gpx -f john.gpx \ - -i gpx -f doe.gpx \ - -x track,merge,title="COMBINED LOG" \ - -o gpx -F john_doe.gpx - - FIX - Fix forces the GPS fix status for all trackpoints to the - specified value. The value may be PPS, DGPS, 3D, 2D, or NONE. - - - gpsbabel -i gpx -f trk.gpx -x track,fix=3D -o nmea -F - - - - COURSE - Course computes a value for the GPS heading at each trackpoint. - This is most useful with trackpoints from formats that don't support - heading information or for trackpoints synthesized by the interpolate - filter. The heading at each trackpoint is simply the course from the - previous trackpoint in the track. The first trackpoint in each track - is arbitrarily assigned a heading of 0 degrees. - - gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F - - - - SPEED - Course computes a value for the GPS speed at each trackpoint. - This is most useful with trackpoints from formats that don't support - speed information or for trackoints synthesized by the interpolate - filter. The speed at each trackpoint is the average speed from the - previous trackpoint (distance/time). The first trackpoint in each - track is assigned a speed of "unknown." - - gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F - - diff --git a/gpsbabel/xmldoc/formats/options/an1-road.xml b/gpsbabel/xmldoc/formats/options/an1-road.xml index 2fbc65076..8cf7a3f81 100644 --- a/gpsbabel/xmldoc/formats/options/an1-road.xml +++ b/gpsbabel/xmldoc/formats/options/an1-road.xml @@ -4,39 +4,48 @@ allows you to change the types of roads based on their names. You can change multiple roads at the same time. Currently supported types are - - - limited - Limited-access freeways - - toll - Limited-access toll highways - - ramp - Access ramps for limited-access highways - - us - National highways (e.g. US routes) - - primary - Primary State/Provincial routes - - state - State/Provincial routes - - major - Major Connectors - - ferry - Ferry Routes - - local - Local Roads - - editable - User-drawn Roads - - + + + limited + Limited-access freeways + + + toll + Limited-access toll highways + + + ramp + Access ramps for limited-access highways + + + us + National highways (e.g. US routes) + + + primary + Primary State/Provincial routes + + + state + State/Provincial routes + + + major + Major Connectors + + + ferry + Ferry Routes + + + local + Local Roads + + + editable + User-drawn Roads + + GPSBabel defaults to creating editable roads. These are routed just like -- 2.30.2